ATSUCopyLineControls

OSStatus ATSUCopyLineControls (
                     ATSUTextLayout iSourceTextLayout,
                     UniCharArrayOffset iSourceLineStart,
                     ATSUTextLayout iDestTextLayout,
                     UniCharArrayOffset iDestLineStart);

iSourceTextLayout

A reference of type ATSUTextLayout. Pass a reference to an initialized text layout object that contains the line whose attribute values you want to copy. You cannot pass NULL for this parameter.

iSourceLineStart

A value of type UniCharArrayOffset. Pass the edge offset of the beginning of the line whose attribute values you want to copy.

iDestTextLayout

A reference of type ATSUTextLayout. Pass a reference to the initialized text layout object containing the line whose attribute values you want to replace. This can be the same text layout object passed in the iSourceTextLayout parameter if you want to copy text layout attributes within a text layout object. You cannot pass NULL for this parameter.

iDestLineStart

A value of type UniCharArrayOffset. Pass the edge offset of the beginning of the line whose attribute values you want to replace.

function result

A result code. See Result Codes.

DISCUSSION

The ATSUCopyLineControls function copies all the text layout attribute values from a line in a text layout object. This includes previously set attributes as well as unset ones, which ATSUI sets to the default values listed in Table C-2. If you wish to copy the text layout attribute values of an entire text layout object to another text layout object, see the function ATSUCopyLayoutControls.

ATSUCopyLineControls does not copy the contents of memory referenced by pointers or handles within reference constants. You are responsible for ensuring that this memory remains valid until the source text layout object is disposed of.

SPECIAL CONSIDERATIONS

ATSUCopyLineControls may allocate memory in your application heap, unless you designate a different heap by calling the function ATSUCreateMemorySetting.

VERSION NOTES

Available beginning with ATSUI 1.1.